package com.imooc.news_manager_project.config;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @project: news_manager_project
 * @author: 13965
 * @date：2023/9/30 13:58
 * @description:
 */
@Configuration
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 配置基本信息
                .apiInfo(apiInfo())
                //是否启用swagger（测试环境下启用，生产环境下不启用）
                .enable(true)
                //调用选择器，后面的内容配置选择器内容
                .select()
                //加了 Api注解 的类，才生成类文档
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                //加了 ApiOperation 注解的方法，才生成接口文档
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 对所有路径进行监控
                .paths(PathSelectors.any())
                //构建
                .build()
                // 创建一个分组
                .groupName("松思园");
    }

    // api 描述基本信息
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 标题
                .title("新闻管理接口文档")
                // 描述
                .description("新闻管理前后端分离，后端接口文档")
                // 接口文档版本号
                .version("1.0")
                // 构建方法
                .build();
    }
}
